<?php

/**
 * Interface declaration for class objects describing a geodetic location
 *
 * This package is not tied to any specific datum. For general applications
 * GRS80 (or its equivalent NAD83 or WGS84) should generally be considered.
 *
 * PHP version 5
 *
 * LICENSE:
 *
 * Copyright (c) 2007-2009, Philippe Jausions / 11abacus
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   - Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   - Neither the name of 11abacus nor the names of its contributors may
 *     be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Structures
 * @package   Structures_Location
 * @author    Philippe Jausions <Philippe.Jausions@11abacus.com>
 * @copyright 2007-2009 by Philippe Jausions / 11abacus
 * @license   http://www.opensource.net/licenses/bsd-license.php New BSD
 */

/**
 * Interface declaration for class objects describing a geodetic location
 * 
 * @category Structures
 * @package  Structures_Location
 * @author   Philippe Jausions <Philippe.Jausions@11abacus.com>
 */
interface Structures_Location_GeodeticInterface
{
    /**
     * Returns the longitude (decimal degrees)
     *
     * @return float
     */
    public function getLongitude();

    /**
     * Returns the latitude (decimal degrees)
     *
     * @return float
     */
    public function getLatitude();

    /**
     * Returns elevation/altitude/height (meters)
     *
     * @return float|NULL 
     */
    public function getElevation();

    /**
     * Sets the longitude
     *
     * <code>
     * // Set as numeric value  
     * $geo->setLongitude(-73.986952);
     * 
     * // Set as array value
     * $geo->setLongitude(array(73, 59, 13.0272, 'W'));
     * </code>
     *
     * @param float|array $long Longitude to set (-180 to 180) or array defining
     *                          the value
     * 
     * @return void
     */
    public function setLongitude($long);

    /**
     * Sets the latitude
     *
     * <code>
     * // Set as numeric value  
     * $geo->setLatitude(40.756053);
     * 
     * // Set as array value
     * $geo->setLatitude(array(40, 45, 21.7908, 'N'));
     * </code>
     * 
     * @param float|array $lat Latitude to set (-90 to 90) or array defining
     *                          the value
     * 
     * @return void
     */
    public function setLatitude($lat);

    /**
     * Sets elevation/altitude/height (meters)
     *
     * @param float $elevation Elevation to set
     * 
     * @return void
     */
    public function setElevation($elevation);
}

?>